This resource address returns information on the specified transaction. The
transaction can be identified either by id or URI. This resource address must include the id
or name of the host that executes the transaction.
URL Parameters
format
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present.
host-id
The id or name of the host that owns the
transaction. This parameter is required.
Request Headers
Accept
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header.
Response Headers
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response
Upon success, MarkLogic Server returns status code 200 (OK). The response body
contains the requested data.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
id
name
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
properties
Characteristics of the transaction.
This is a complex structure with the following children:
seconds-elapsed
How long the transaction has been
open.
xid
The Xid.
This is a complex structure with the following children:
global-transaction-id
The global transaction ID of a Xid.
branch-qualifier
The branch qualifier of a Xid.
transaction-mode
The mode of a transaction
transaction-timestamp
The timestamp of a transaction
transaction-state
The state of a transaction
canceled
Has this transaction been canceled.
start-time
The time a backup or restore started.
time-limit
The transaction's time limit, in seconds.
max-time-limit
The upper bound for a transaction's time limit, in seconds.
join-size
An indication of the current size of the join tables created under this transaction.
join-size-strings
An indication of the current size of the join tables created under this transaction.
user
The unique ID of the user executing the transaction.
admin
If the transaction has admin privileges.
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/transactions/10251787240502259323?host-id=myhost
==> Returns information on the transaction with the id 10251787240502259323
on the host, 'myhost'.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.